home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / telecomm / wa200.lzh / WHATARC.DOC < prev    next >
Text File  |  1990-10-29  |  10KB  |  240 lines
  1. ========================================================================
  2.  ====                                                              ====
  3.   ==                          WhatArc v2.00                         ==
  4.   ==  an ARCmail utility written by Jon Webb, DeltaVision Systems   ==
  5.   ==                 with a little help from Theo Runia             ==
  6.  ====                                                              ====
  7. ========================================================================
  8.  
  9.                          NOTES FOR 1.0x USERS
  10.                          ====================
  11.  
  12.      This  version of WhatArc has quite a few changes.  Your  old 
  13.      configuration  file  will need  changing.  This  version  of 
  14.      WhatArc should work fine on a TT.
  15.  
  16.                              INTRODUCTION
  17.                              ============
  18.  
  19.      WhatArc  was created to enable the use of  ARCmail,  ZIPmail 
  20.      and  LZHmail  simultaneously  on  a  The-Box  or  Binkley/ST 
  21.      system.  The utilities which usually call ARC.TTP to  create 
  22.      ARCmail,  should call WHATARC.TTP with  the same parameters. 
  23.      Here's what WhatArc does...
  24.  
  25.         » IMPORTING an archived mail packet:
  26.  
  27.           »» Read configuration
  28.           »» Find archived mail packet
  29.           »» Examine archive header
  30.           »» Call archive program
  31.  
  32.         » EXPORTING an archived mail packet:
  33.  
  34.           »» Read configuration
  35.           »» Find un-archived mail packet
  36.           »» Examine packet header
  37.           »» Match node number with configuration file
  38.           »» Call archive program
  39.  
  40.      Import is easy,  it just looks at the first few bytes of the 
  41.      incoming   archive,  and  calls one  of  three  de-archiving 
  42.      programs.   Export   is   a   little   more   complex.   The 
  43.      configuration  file  contains some node  numbers  and  their 
  44.      packing methods. Depending on the node number in  the packet 
  45.      header,  and  the  node numbers in the  configuration  file,  
  46.      either ARC, ZIP or LHArc is called.
  47.  
  48.                         THE CONFIGURATION FILE
  49.                         ======================
  50.  
  51.      WhatArc   gets   its  configuration  from  a   file   called 
  52.      WHATARC.CTL,  which   must  be located in  either  the  home 
  53.      directory,  or  the  directory  to   which  the  environment 
  54.      variables  MAILER or BINKLEY point.
  55.  
  56.      Due  to  a bug in Import the  environment  variables  aren't 
  57.      passed to WhatArc.  In that case WhatArc will attempt to use 
  58.      the environment passed to Import.
  59.  
  60.      WHATARC.CTL  is  a plain ascii  file which  contains  a  few 
  61.      lines of text.  These lines can contain  keywords.  Comments 
  62.      should be preceded by a semi-column (;). Valid keywords are:
  63.  
  64.         » LOG <filespec>
  65.  
  66.           This  should  be  the first keyword  in  the  file.  It 
  67.           defines  what  log file you want  WhatArc  to  use.  If 
  68.           omitted,  a  file  called WHATARC.LOG  in  the  current 
  69.           directory  will be used.  Logging will not work if  you 
  70.           specify the The-Box log file, because Import and Export 
  71.           keep the log file open when running the archiver.
  72.  
  73.           Example:
  74.  
  75.              LOG d:\tb\whatarc.log
  76.  
  77.         » SCREEN <kb>
  78.  
  79.           When  this keyword is found,  the screen will be  saved 
  80.           on  startup and restored on exit.  The  <kb>  parameter 
  81.           defines how many Kb are required for the archivers.  If 
  82.           there is not enough RAM,  the screen just isn't  saved. 
  83.           Example:
  84.  
  85.              SCREEN 128
  86.  
  87.         » ARC_X <program> <mask>
  88.         » ZIP_X <program> <mask>
  89.         » LZH_X <program> <mask>
  90.  
  91.           These keywords define the location of the ARC,  ZIP and 
  92.           LZH extractor programs.  The <program> parameter should 
  93.           be  the  path and name of  the  extractor.  The  <mask> 
  94.           parameter defines the command line which will be passed 
  95.           to  the  extractor.   It  can  contain  the   following 
  96.           placeholders:
  97.  
  98.           »» %1     is replaced by the path of the archived file,
  99.           »» %2     is replaced by the name of the archived file,
  100.           »» %3     is replaced by the path of the packet,
  101.           »» %4     is replaced by the name of the packet.
  102.  
  103.           The  paths  _do_not_  include  a  trailing   backslash. 
  104.           Examples:
  105.  
  106.              ARC_X d:\tb\arc\arc.ttp xo %1\%2 %3\%4
  107.              ZIP_X d:\tb\arc\unzip.ttp x %1\%2 %3\
  108.  
  109.         » ARC_A <program> <mask>
  110.         » ZIP_A <program> <mask>
  111.         » LZH_A <program> <mask>
  112.  
  113.           These  keywords  define the ARC,  ZIP and  LZH  creator 
  114.           programs.  The  <program> and <mask> parameter  are  as 
  115.           described above.
  116.  
  117.           IMPORTANT:  When using Export you should use a  command 
  118.           line to MOVE the files into the archive,  not just  add 
  119.           them.
  120.  
  121.           Examples:
  122.  
  123.              ARC_A d:\tb\arc\arc.ttp m %1\%2 %3\%4
  124.              LZH_A d:\tb\arc\lharc.ttp mu %1\%2 %3\%4
  125.  
  126.         » DEFAULT <type>
  127.  
  128.           With this keyword you choose what type of archived mail 
  129.           is   sent  to  nodes  which  aren't  defined   in   the 
  130.           configuration file. Type can be:
  131.  
  132.           »» ARCmail
  133.           »» LZHmail
  134.           »» ZIPmail
  135.  
  136.           Example:
  137.  
  138.              DEFAULT ARCmail
  139.  
  140.         » SEND <node> <type>
  141.  
  142.           is used to define what type of archived mail should  go 
  143.           to  a certain node.  The node number should  either  in 
  144.           format  Zone:Net/Node  or  just  Net/Node.  The  <type> 
  145.           parameter  is as described above.  Example:  I want  to 
  146.           send  ZIPmail to 2:282/350,  but LZHmail to  2:282/301. 
  147.           All   the   other  nodes  should   get   ARCmail.   The 
  148.           configuration file would contain:
  149.  
  150.              DEFAULT ARCmail
  151.              SEND    2:282/301 LZHmail
  152.              SEND    2:282/350 ZIPmail
  153.  
  154.           Points  should use the real address of their  boss.  If 
  155.           you are a boss yourself,  use the fake address of  your 
  156.           points.
  157.  
  158.           Please note that you should _never_ send archived  mail 
  159.           to  a system without _first_ asking the sysop  of  that 
  160.           system whether he is capable of accepting archived mail 
  161.           and - if so - what sort of archiver should be used.
  162.  
  163.      An example configuration file is included in the archive.
  164.  
  165.                     USE WITH EXPORT.TTP/IMPORT.TTP
  166.                     ==============================
  167.  
  168.      The  easiest  way to get Export and Import  to  use  WhatArc 
  169.      instead  of  ARC is to put ARC in a different directory  and 
  170.      rename WHATARC.TTP to  ARC.TTP.  However,  Export and Import 
  171.      can  be  told to use a different  archiver  in  the  command 
  172.      line...
  173.  
  174.         Export normal:   EXPORT -a \TB\WHATARC.TTP m
  175.         Export crash:    EXPORT -fa<node> -a \TB\WHATARC.TTP m
  176.         Export points:   EXPORT -ma<boss> -a \TB\WHATARC.TTP m
  177.         Import:          IMPORT -a \TB\WHATARC.TTP x
  178.  
  179.      Have a look at the import/export docs for more  information. 
  180.      You could write a simple batchfile to handle the parameters. 
  181.      You  MUST   put  the -a option LAST  on  the  command  line, 
  182.      because  all  options after  the -a are considered  part  of 
  183.      that  command  line  for  the  archiver.  Don't  forget  the 
  184.      parameters can only be 'A' for Add,  'M' for Move or 'X' for 
  185.      Extract. Add and Move are treated the same way by WhatArc.
  186.  
  187.                          A NOTE ON ARCHIVERS
  188.                          ===================
  189.  
  190.      There are many different versions of archivers going around. 
  191.      You  should  pick  one which  doesn't  require  user  input, 
  192.      checks CRC's and returns correct errorlevels.  I myself  use 
  193.      TCARC v1.10 and LHarc-ST v0.60. You may want to try ARC 6.02 
  194.      or LHarc v1.13.
  195.  
  196.      I have not yet seen a ZIP creator for the ST.  I only  built 
  197.      the  ZIP  creation  option  in  just  in  case  one  becomes 
  198.